org.springframework.http.client

Class HttpComponentsAsyncClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.HttpComponentsClientHttpRequestFactory

org.springframework.http.client.HttpComponentsAsyncClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, InitializingBean, AsyncClientHttpRequestFactory, ClientHttpRequestFactory

public class HttpComponentsAsyncClientHttpRequestFactory
extends HttpComponentsClientHttpRequestFactory
implements AsyncClientHttpRequestFactory, InitializingBean

Asynchronous extension of the HttpComponentsClientHttpRequestFactory. Uses Apache HttpComponents HttpAsyncClient 4.0 to create requests.

Since:

4.0

Author:

Arjen Poutsma, Stephane Nicoll

See Also:

HttpAsyncClient

Field Summary

Fields

Modifier and Type	Field and Description
private CloseableHttpAsyncClient	httpAsyncClient

Constructor Summary

Constructors

Constructor and Description
HttpComponentsAsyncClientHttpRequestFactory() Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with a default HttpAsyncClient and HttpClient.
HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpAsyncClient httpAsyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpAsyncClient instance and a default HttpClient.
HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpClient httpClient, CloseableHttpAsyncClient httpAsyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpClient and HttpAsyncClient instances.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
AsyncClientHttpRequest	createAsyncRequest(java.net.URI uri, HttpMethod httpMethod) Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.
protected RequestConfig	createRequestConfig(HttpAsyncClient client) Create a default RequestConfig to use with the given client.
void	destroy() Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.
CloseableHttpAsyncClient	getHttpAsyncClient() Return the HttpClient used for asynchronous execution.
void	setHttpAsyncClient(CloseableHttpAsyncClient httpAsyncClient) Set the HttpClient used for asynchronous execution.
private void	startAsyncClient()

Methods inherited from class org.springframework.http.client.HttpComponentsClientHttpRequestFactory

createHttpContext, createHttpUriRequest, createRequest, getHttpClient, getInternalRequestConfig, mergeRequestConfig, postProcessHttpRequest, setBufferRequestBody, setConnectionRequestTimeout, setConnectTimeout, setHttpClient, setReadTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpAsyncClient

private CloseableHttpAsyncClient httpAsyncClient

Constructor Detail

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory()

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with a default HttpAsyncClient and HttpClient.

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpAsyncClient httpAsyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpAsyncClient instance and a default HttpClient.

Parameters:

httpAsyncClient - the HttpAsyncClient instance to use for this request factory

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpClient httpClient,
                                                   CloseableHttpAsyncClient httpAsyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpClient and HttpAsyncClient instances.

Parameters:

httpClient - the HttpClient instance to use for this request factory

httpAsyncClient - the HttpAsyncClient instance to use for this request factory

Method Detail

setHttpAsyncClient

public void setHttpAsyncClient(CloseableHttpAsyncClient httpAsyncClient)

Set the HttpClient used for asynchronous execution.

getHttpAsyncClient

public CloseableHttpAsyncClient getHttpAsyncClient()

Return the HttpClient used for asynchronous execution.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

startAsyncClient

private void startAsyncClient()

createAsyncRequest

public AsyncClientHttpRequest createAsyncRequest(java.net.URI uri,
                                                 HttpMethod httpMethod)
                                          throws java.io.IOException

Description copied from interface: AsyncClientHttpRequestFactory

Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.

The returned request can be written to, and then executed by calling AsyncClientHttpRequest.executeAsync().

Specified by:

createAsyncRequest in interface AsyncClientHttpRequestFactory

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

Returns:

the created request

Throws:

java.io.IOException - in case of I/O errors

createRequestConfig

protected RequestConfig createRequestConfig(HttpAsyncClient client)

Create a default RequestConfig to use with the given client. Can return null to indicate that no custom request config should be set and the defaults of the HttpAsyncClient should be used.

The default implementation tries to merge the defaults of the client with the local customizations of this instance, if any.

Overrides:

createRequestConfig in class HttpComponentsClientHttpRequestFactory

Parameters:

client - the client

Returns:

the RequestConfig to use

Since:

4.2

destroy

public void destroy()
             throws java.lang.Exception

Description copied from class: HttpComponentsClientHttpRequestFactory

Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class HttpComponentsClientHttpRequestFactory

Throws:

java.lang.Exception - in case of shutdown errors. Exceptions will get logged but not rethrown to allow other beans to release their resources too.